{namespace exports}


/**
 * Print the usage string for the app.
 */
{template .usage autoescape="false"}
{literal}Relief Doc Utility
rdoc.js [-h] [-a] [-i|-c filename]
{/literal}
{/template}


/**
 * Help text to be printed after the above .usage template and the command line
 * argument list.
 */
{template .help}
{literal}rdoc can be run on a single input file or it can be given a Plovr-compatible
config file containing input and/or path lists to specify which file(s) to
document.

Config files should contain one or both of the following properties:

inputs {string|Array.<string>} A filename or array of filenames of javascript
        source files that should be documented.

paths {string|Array.<string>} A directory or array of directories to be searched
        for javascript source files.  Directories will be searched recursively.

If a config file includes a "paths" property, it may also include a "pathNames"
property which maps path entries to more human-readable names.  These are used
in the file names and in the HTML documentation.  For example:

  "pathNames": {
    "/devel/closure-library/closure/": "Closure Library",
    "/devel/closure-library/third_party/closure/": "Closure Third Party",
    "/devel/relief/": "relief"
  },

could be used to map these inputs to actual, independent project names.

Config files may contain "rdoc-exclude-prefix", "rdoc-exclude-suffix", or
"rdoc-exclude" properties that point to arrays of strings.  These will be
checked against both paths and file names.  Matching files or directories will
be excluded.  For example, your config file may include

{
    "rdoc-exclude-suffix": ["_test.js"]
}

to skip your app's test scripts.

Config files must contain the following property:

jsdoc-html-output-path {string} A path to a directory into which documentation
        files should be saved.
{/literal}
{/template}
